/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.schema.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.hisp.dhis.schema.PropertyType;

/**
 * @author Morten Olav Hansen <mortenoh@gmail.com>
 */
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Property {
  org.hisp.dhis.schema.PropertyType value() default PropertyType.DEFAULT;

  Value required() default Value.DEFAULT;

  Value persisted() default Value.DEFAULT;

  Value owner() default Value.DEFAULT;

  Access access() default Access.READ_WRITE;

  /**
   * This is essentially a manual override to specify the {@link
   * org.hisp.dhis.schema.Property#getFieldName()} of the annotated member.
   *
   * @return Name of the field this property is persisted as in case this is a non persistent
   *     property which has a corresponding persistent member.
   */
  String persistedAs() default "";

  enum Value {
    TRUE,
    FALSE,
    DEFAULT
  }

  enum Access {
    READ_ONLY,
    WRITE_ONLY,
    READ_WRITE;

    public boolean isReadable() {
      return READ_ONLY == this || READ_WRITE == this;
    }

    public boolean isWritable() {
      return WRITE_ONLY == this || READ_WRITE == this;
    }
  }
}
